System Booster

home *** CD-ROM | disk | FTP | other *** search

/ System Booster / System Booster.iso / Texteditors / Origami / man / origami.man < prev next >

Wrap

Text File | 1996-09-27 | 18.4 KB | 463 lines

ORIGAMI(1) ORIGAMI(1) NNAAMMEE origami - a folding editor, version >>>MAJOR_VERSION<<<.>>>MINOR_VERSION<<<.>>>REVISION<<< SSYYNNOOPPSSIISS oorriiggaammii [--eehhiinnooppvvAACCDDPPVVZZ] [--aa _d_e_l_a_y] [--dd _d_i_s_p_l_a_y_-_m_o_d_e] [--ff _m_a_t_c_h] [--kk _n_a_m_e] [--ll _l_i_n_e] [--mm _m_a_r_k_s] [--tt _h_a_r_d_-_t_a_b_-_w_i_d_t_h] [--FF _n_o_m_a_t_c_h] [--KK _A||_N] [--MM _m_a_r_k_s] [--NN _n_u_m_b_e_r] [--OO _o_c_l_- _v_a_l_u_e] [--RR _>_>_>_R_C___E_N_D_I_N_G_<_<_<_-_p_a_t_h] [--SS _s_h_e_l_l] [--TT _d_e_f_a_u_l_t_- _n_a_m_e] [--XX _o_s _s_p_e_c_i_f_i_c _o_p_t_i_o_n] [--WW _w_i_n_d_o_w _n_a_m_e] [_f_i_l_e_s] DDEESSCCRRIIPPTTIIOONN OOrriiggaammii is a folding editor similar to the one included in the Inmos(c) Tds or Parsytec(c) MultiTool Transputer Development Systems. The major difference is that OOrriiggaammii is public domain, the differences concern its usage and more features, for example the macro language OCL. You can use OOrriiggaammii for usual text files without null- characters. Tds/mtool files can be edited too. If OOrriiggaammii is started within a pipe, it appends the text coming from its standard input to the chosen text and tries to open the controlling terminal for controlling the editor session. If no file is given, //ddeevv//nnuullll is used. The cursor is moved to the beginning of the piped text. If the special character to generate signal stop (stty susp ..) is not defined, command line option --ZZ is acti- vated automatically. OOPPTTIIOONNSS --aa _d_e_l_a_y, 1<=_d_e_l_a_y<=60 OOrriiggaammii will start in auto-save-mode with _d_e_l_a_y minutes (--aa 00, no auto-save). Multiple usage of this option is allowed. The last given value is used. Default value is 8. --dd _d_i_s_p_l_a_y_-_m_o_d_e Specify the character display mode. _f_I_d_i_s_p_l_a_y_-_m_o_d_e is a list of code (like in sseett--ddiissppllaayy--mmooddee). oo - octal display dd - decimal display hh - hexadecimal display mm - mark control characters ii - invers control characters nn - numbered control characters pp - normal character display 88 - numbered display of 8-bit characters aa - numbered display of all characters tt_n_u_m_b_e_r - tab width is set to _n_u_m_b_e_r --ee OOrriiggaammii does not echo the entered keys under the statusline. June 23, 1993 1 ORIGAMI(1) ORIGAMI(1) --ff _m_a_t_c_h OOrriiggaammii will pass '--ff _m_a_t_c_h' to ddiirrffoolldd. Can be used to specify the files, which will be shown in diredit mode. --hh OOrriiggaammii prints its usage. --ii Like --ddii. --kk _n_a_m_e_b_a_s_e OOrriiggaammii reads the keybinding and the bindinglist from file ..oorriiggaammiirrcc, the help from ..oorriiggaammiihheellpp. This option sets the files to _n_a_m_e_b_a_s_errcc and _n_a_m_e_- _b_a_s_ehheellpp. If OOrriiggaammii cannot find the files in the current directory, OOrriiggaammii tries to find the files in the directories $$HHOOMMEE or OORRIIGGAAMMII__PPAATTHH (set at compiletime). Origami searches only in the resource path, if the given argument _n_a_m_e_b_a_s_e is not an absolute path. This option is not allowed, if --OO has been used before! --ll _l_i_n_e Goto _l_i_n_e after setting up. Multiple usage of --ll .. is not allowed. --mm _m_a_r_k_n_a_m_e OOrriiggaammii searches in the rcfile for a set of fold- marks named _m_a_r_k_n_a_m_e. If there is no such markset given, OOrriiggaammii will stop. Otherwise the marks for folds are switched to the new ones. Multiple usage of --mm .. is not allowed. --nn Every time a file is read this will take place without the {{{{{{, }}}}}} or :::::: sequences being parsed. Folds can be used when editing, but there is no folding-structure in the read file. This allows the editing of files which contain these strings without confusing OOrriiggaammii. The Inmos format will not be decoded if this option is active. This `non-folding' mode concerns only reading files. Creating new folds or writing files using language Inmos is possible. --oo OOrriiggaammii starts in overwrite-mode. --pp Preprocessormode is on. Leading hashes are moved to first character in lines. Reading such files moves hashes to indentation of surrounding folds. --tt _t_a_b_-_w_i_d_t_h Like --ddtt_<_t_a_b_-_w_i_d_t_h_>. --vv OOrriiggaammii starts in view-mode. June 23, 1993 2 ORIGAMI(1) ORIGAMI(1) --AA OOrriiggaammii starts not with the first file in command line, but with the list of given files. This option is ignored, if there are not more than 1 command line file or if OOrriiggaammii is started within a pipe. --CC Do not display the copyright message at startup. --DD Dump core on crash. --FF _n_o_m_a_t_c_h OOrriiggaammii will pass '--FF _n_o_m_a_t_c_h' to ddiirrffoolldd. Can be used to specify the files, which will not be shown in diredit mode. --KK_A,--KK_N Origami changes the mode of the keypad to applica- tion (_A) or numerical (_N) mode at startup, if the terminal supports this. Default is application (_A). --MM_m_a_r_k_s Folder replaces the foldmarks by the characters given with _m_a_r_k_s. aaaaaabbbbbbccccccdddddd is evaluated: aaaaaa for start of fold bbbbbb for filed fold name cccccc for closed fold dddddd for end of fold None of these strings may start with a space or a tab! --NN _n_u_m_b_e_r If OOrriiggaammii is compiled with support for storing lines on backing store, this options sets the num- ber of buffered lines. --OO _o_c_l_-_v_a_l_u_e Change the value of OCL integer variable ooccll-- aarrgguummeenntt to _o_c_l_-_v_a_l_u_e. If the current bindings supports it, you can use literals. oorriiggaammii [--kk_b_i_n_d_i_n_g] --hh will show all known literals. See in the User Manual for more advanced options. Mul- tiple usage of this option is allowed. If this option is not used, ooccll--aarrgguummeenntt is initialized with --11. --PP Don't open the controlling terminal, if called in a pipe. --RR _r_c_-_p_a_t_h Specify the path list for origami resource files. --SS _s_h_e_l_l Secure mode is activated. June 23, 1993 3 ORIGAMI(1) ORIGAMI(1) Pipe-commands are disabled and shell-commands use _s_h_e_l_l. If _s_h_e_l_l is the empty word, shell-commands are also disabled. If --SS_s_h_e_l_l is used, the only pipe, called by Origami, is 'ddiirrffoolldd _._._.', to han- dle the editing of directories. --TT _d_e_f_a_u_l_t_-_n_a_m_e This option is only available, if OOrriiggaammii is com- piled to support xterms. In this case, this option enables OOrriiggaammii to set the xterm window name to the name of the current file. After OOrriiggaammii has fin- ished, the window name is changed to _d_e_f_a_u_l_t_-_n_a_m_e. Multiple usage of this option is allowed. The last given value is used. If the given value is the empty string, xxtteerrmm is used. --XX _o_s _s_p_e_c_i_f_i_c _o_p_t_i_o_n Some special versions of OOrriiggaammii use this option to handle additional features. See the OS-specific documents for more information. --VV OOrriiggaammii starts in verbose-mode. --WW _w_i_n_d_o_w _n_a_m_e _w_i_n_d_o_w _n_a_m_e will be displayed in the statusline, in front of the filename. _w_i_n_d_o_w _n_a_m_e will also appear in the title of xterms, if --TT is used. This is intended for users of Virtual Terminal environments such as Screen, where the Terminal Name can be stored in an environment variable. This means one can distinguish between several sessions on several terminals. --ZZ OOrriiggaammii cannot be stopped via ssuussppeenndd--oorriiggaammii. EENNVVIIRROONNMMEENNTT >>>>>>HHOOMMEE<<<<<< value for expanding ~~ or ~~//. >>>>>>TTEERRMM<<<<<< get the currently used terminal typ. >>>>>>OORRIITTEERRMM<<<<<< read the keytable for terminal $$>>>>>>OORRIITTEERRMM<<<<<<, not for terminal $$>>>>>>TTEERRMM<<<<<<. >>>>>>SSHHEELLLL<<<<<< specify the shell for shell escapes. >>>>>>OORRIIAARRGG<<<<<< can be used, to specify default options. These options are handled, before any command line options are read. Origami reads the string and divides the space/tab separated substrings into a June 23, 1993 4 ORIGAMI(1) ORIGAMI(1) new argument list. >>>>>>OORRIIPPAATTHH<<<<<<,>>>>>>OORRIIPPAATTHH__11<<<<<< specifies the list of directories, Origami uses to store its resource files. >>>ORI_RC_PATH_MANTEXT<<< DDIIAAGGNNOOSSTTIICCSS OOrriiggaammii complains, if the needed resource files are not online or if OOrriiggaammii cannot get needed information from termcap or if OOrriiggaammii produces the following exit status codes (brack- eted values represent the UNIX standard values for the given symbolic names): EX_OK(0) normal termination EX_USAGE(64) given arguments were incorrect EX_NOINPUT(66) OOrriiggaammii cannot read from its inputstream EX_UNAVAILABLE(69) init of screen or keyboard failed., or >>>RC_ENDING<<<-file error EX_SOFTWARE(70) internal OCL-error or line to long (shifting of folds). EX_OSERR(71) memory full, OOrriiggaammii cannot malloc memory for new text nodes EX_CANTCREATE(73) file was changed and not saved before exit- ing OOrriiggaammii The following exit codes are not standard unix exit codes: 1 deadly signal arrived, OOrriiggaammii tries to dump changed files 2 internal memory management for virtual line handling crashed, maybe the tmp-file is dam- aged 3 exiting OOrriiggaammii cannot give a proper return- value, should never appear June 23, 1993 5 ORIGAMI(1) ORIGAMI(1) BBUUGGSS AANNDD LLIIMMIITTAATTIIOONNSS Linelength is limited by >>>LINELEN<<<. In language IInnmmooss Origami will warn, if lines are longer then >>>TDS_LEN<<<. Reading a file with fold-structure needs searching for {{{{{{, }}}}}} and :::::: (or the ones, given with --mm_m_a_r_k_n_a_m_e). This is done with little checking the right comment syn- tax. Files containing such strings in a non folding con- text are not guaranteed to be handled properly. Use com- mand line option --nn or --mm to prevent problems. OOrriiggaammii uses the following rules to handle incorrect files: incorrect user comment type If the comment language is already defined (either by a {{{{{{}}}}}}-line or a fold line, using a predefined fold language) and a {{{{{{}}}}}}-line appears, this line is handled as normal text. Writing such files can be tricky. In the written file, the language comment appears at the first fold first. If the {{{{{{}}}}}}-line is in front of that first fold, OOrriiggaammii may not be able, to read the file with folds. multiple comment types Each file may only use one comment syntax. All foldmarks using another comment syntax than the first one are handled as normal text. This can be used to edit files with {{{{{{, .., if you add an empty fold in front of your text. missing ooppeenn--ffoolldd-lines cclloossee--ffoolldd-lines without corresponding ooppeenn-- ffoolldd-lines are handled as normal text. missing cclloossee--ffoolldd-lines Folds with missing cclloossee--ffoolldd-lines are closed at eenndd--ooff--ffiillee. OOrriiggaammii complains and adds a new commented line, containing the number of automatically closed folds, at end of the file. This error handling is not active, while reading the binary TTDDSS-format. If TTDDSS-files are corrupted, OOrriiggaammii tries to dump a core and exits. OOrriiggaammii doesn't check, if changing the indentation of a closed fold generates lines longer the permitted line- length. Changing the fold comment language from Inmos to another language can remove additional information about fold- June 23, 1993 6 ORIGAMI(1) ORIGAMI(1) types and can destroy the fold structure. Though we use a better format, to represent Inmos-files in ASCII, we can- not guarantee, that this coding is perfect. Be careful and test, if the format is secure for your application. Tabs are only allowed in places, where normal text charac- ters are allowed too. There is no pretty way to allow tabs in front of the indentation level of a fold. OOrriiggaammii uses the first of the following facilities to mark highlighted text: ssoo/ssee - standout mmrr/mmee - reverse video uuss/uuee - underscore The Option --ii will be ignored, if no highlighting can be done. Aborting running macros on terminals with xxss may be buggy concerning cleaning standout mode. A full redraw will solve this problem. OOrriiggaammii uses the termcap capabilities ccoo (number of columns) and llii (number of lines) to read the window size. Therefor a correct handling of resized windows is only possible, if ttggeettnnuumm((""llii"")) and ttggeettnnuumm((""ccoo"")) return the correct window size. If the environment variable >>>>>>TTEERRMM<<<<<< is set to xxtteerrmm, OOrriiggaammii uses a special escape sequence to read the window size directly from the xterm. SSEEEE AALLSSOO autoalias(1), dirfold(1), getopt(3), keybind(1), viewrc(1), Origami User Manual June 23, 1993 7